API Documentation
Public Member Functions | List of all members
nkWinUi::LogWin Class Reference

A graphical log window, where lines can be added like a console log. More...

Inheritance diagram for nkWinUi::LogWin:
nkWinUi::Component nkExport::Exportable

Public Member Functions

 LogWin ()
 
 ~LogWin ()
 
unsigned int getMaxLine () const
 
virtual const ScrollBargetVerticalScrollBar () const
 
void setMaxLine (unsigned int val)
 
virtual void addLine (const nkMemory::StringView &line)
 
virtual void clear ()
 
virtual void exportIntrospection (nkExport::Node *rootNode) override
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkWinUi::Component
 Component ()
 
virtual ~Component ()
 
LayoutgetLayout () const
 
ThemegetTheme () const
 
nkMaths::Point getPositionInParent () const
 
nkMaths::Point getPositionInScreen () const
 
int getWidth () const
 
int getHeight () const
 
nkMaths::Rectangle getAreaInParent () const
 
nkMaths::Rectangle getAreaInScreen () const
 
virtual nkMaths::Point getBorderExtents () const
 
virtual int getLayoutAllowedWidth () const
 
virtual int getLayoutAllowedHeight () const
 
virtual int getLayoutAllowedOffsetX () const
 
virtual int getLayoutAllowedOffsetY () const
 
bool isInitialized () const
 
ComponentgetParentComponent () const
 
COMPONENT_TYPE getComponentType () const
 
nkMemory::StringView getComponentName () const
 
bool getVisibility () const
 
virtual nkMemory::StringView getLabel () const
 
void * getData () const
 
bool isEnabled () const
 
bool isForegroundWindow () const
 
unsigned int getZDepth () const
 
bool getVisibleOnLoad () const
 
virtual LayoutsetLayout (LAYOUT_TYPE layoutType)
 
virtual void setTheme (Theme *theme)
 
virtual void setPositionInParent (nkMaths::Point position)
 
virtual void setPositionInScreen (nkMaths::Point position)
 
virtual void setSize (int width, int height)
 
virtual void setWidth (int width)
 
virtual void setHeight (int height)
 
void setMinSize (unsigned int width, unsigned int height)
 
void setMaxSize (unsigned int width, unsigned int height)
 
void setRatio (float widthOverHeight)
 
virtual void setAreaInParent (const nkMaths::Rectangle &area)
 
virtual void setAreaInScreen (const nkMaths::Rectangle &area)
 
virtual void setParentComponent (Component *parent, bool makeItVisible=true)
 
virtual void setLabel (const nkMemory::StringView &label)
 
void setComponentName (const nkMemory::StringView &name)
 
virtual void setVisibility (bool value)
 
void setData (void *data)
 
void setEnabled (bool value)
 
void setVisibleOnLoad (bool value)
 
void addChild (Component *child, bool makeItVisible=true)
 
void removeChild (Component *child)
 
void removeChild (unsigned int index)
 
ComponentgetChild (unsigned int index)
 
unsigned int getChildIndex (Component *child)
 
void unloadWithChildren ()
 
void loadWithChildren ()
 
void updateZDepth ()
 
void bringToForeground ()
 
void focusWindow ()
 
nkMaths::Point getCoordRelativeFromAbsolute (const nkMaths::Point &absCoords)
 
nkMaths::Point getCoordAbsoluteFromRelative (const nkMaths::Point &relCoords)
 
virtual void load ()=0
 
virtual void unload ()=0
 
virtual void updateWindow ()
 
nkImages::Image paintToImage (bool withFrame=false)
 
void simulateEvent (const InputDescriptor &inputDescription)
 
void onSized ()
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

A graphical log window, where lines can be added like a console log.

Constructor & Destructor Documentation

◆ LogWin()

nkWinUi::LogWin::LogWin ( )

Constructor.

◆ ~LogWin()

nkWinUi::LogWin::~LogWin ( )

Destructor.

Member Function Documentation

◆ getMaxLine()

unsigned int nkWinUi::LogWin::getMaxLine ( ) const
Returns
The maximum line number the history of the window will have.

◆ getVerticalScrollBar()

virtual const ScrollBar* nkWinUi::LogWin::getVerticalScrollBar ( ) const
virtual
Returns
The vertical scrollbar attached to the LogWin, if any.

◆ setMaxLine()

void nkWinUi::LogWin::setMaxLine ( unsigned int  val)

Sets the maximum number of lines the history of the window will have.

Parameters
valThe number of lines the history will hold.

◆ addLine()

virtual void nkWinUi::LogWin::addLine ( const nkMemory::StringView line)
virtual

Add a new line.

Parameters
lineThe new line to log.

◆ clear()

virtual void nkWinUi::LogWin::clear ( )
virtual

Clears all logged lines in the component.

◆ exportIntrospection()

virtual void nkWinUi::LogWin::exportIntrospection ( nkExport::Node rootNode)
overridevirtual

◆ importClassFromTree()

virtual void nkWinUi::LogWin::importClassFromTree ( nkExport::Node rootNode)
overridevirtual

The documentation for this class was generated from the following file: